﻿// ———————————————————————–
// <copyright file="LocationCreationCode.cs" company="The MITRE Corporation">
//    Copyright (c) 2014 The MITRE Corporation. All rights reserved.
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//    http://www.apache.org/licenses/LICENSE-2.0
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.
// </copyright>
// ———————————————————————–
/////////////////////////////////////////////////////////////////////////////////////////////////
// LocationCreationCode.cs:
//
// Type of relationship in EM Event Link
//
// Project: IC.NET - CAD Library
// Author:  Jim Cronin - MITRE
/////////////////////////////////////////////////////////////////////////////////////////////////

// Copyright (c) 2014 The MITRE Corporation. All rights reserved.
//
// NOTICE
// This software was produced for the U. S. Government
// under Contract No. FA8721-09-C-0001, and is
// subject to the Rights in Noncommercial Computer Software
// and Noncommercial Computer Software Documentation Clause
// (DFARS) 252.227-7014 (JUN 1995)

using System;
using System.Xml;

namespace EDXLSharp.NIEMCore
{
  /// <summary>
  /// A data type for a code indicating the method used to generate a location.
  /// </summary>
  public class LocationCreationCode : IComposable
  {
    /// <summary>
    /// Location Create Code
    /// </summary>
    public string Code { get; private set; }

    public LocationCreationCode()
    {
    }

    public LocationCreationCode(string code)
      : this()
    {
      this.Code = code;
    }

    /// <summary>
    /// Writes this Object to an inline XML Document
    /// </summary>
    /// <param name="xwriter">Valid XMLWriter</param>
    /// <exception cref="System.ArgumentNullException">Thrown if xwriter is null</exception>
    /// <exception cref="EDXLSharp.ValidationException">Thrown if the object fails to validate</exception>
    public void WriteXML(XmlWriter xwriter)
    {
      if (xwriter == null)
      {
        throw new ArgumentNullException("xwriter");
      }

      xwriter.WriteElementString(EDXLConstants.MilopsPrefix, "LocationCreationCode", EDXLConstants.MilopsNamespace, this.Code);
    }

    /// <summary>
    /// Reads this Object's values from an XML NodeList
    /// </summary>
    /// <param name="rootnode">Root XML Node of the Object Element</param>
    /// <exception cref="System.ArgumentNullException">Thrown if rootnode is null</exception>
    /// <exception cref="System.ArgumentException">Thrown if the rootnode is not the correct type</exception>
    /// <exception cref="EDXLSharp.ValidationException">Thrown if the object fails to validate</exception>
    public void ReadXML(XmlNode rootnode)
    {
      if (rootnode == null)
      {
        throw new ArgumentNullException("rootnode");
      }
      if (rootnode.LocalName != "LocationCreationCode")
      {
        throw new ArgumentException("Node is not LocationCreationCode");
      }

      this.Code = rootnode.InnerText;
    }

    /// <summary>
    /// Validates This Message element For Required Values and Conformance
    /// </summary>
    /// <exception cref="EDXLSharp.ValidationException">Thrown if the object fails to validate</exception>
    public void Validate()
    {
    }

    /// <summary>
    /// Human entered or modified
    /// </summary>
    public static readonly LocationCreationCode Human = new LocationCreationCode("HUMAN");
    /// <summary>
    /// Estimated by user
    /// </summary>
    public static readonly LocationCreationCode HumanEstimated = new LocationCreationCode("HUMAN.ESTIMATED");
    /// <summary>
    /// Calculated by user
    /// </summary>
    public static readonly LocationCreationCode HumanCalculated = new LocationCreationCode("HUMAN.CALCULATED");
    /// <summary>
    /// Transcribed by user (from voice, paper, etc.)
    /// </summary>
    public static readonly LocationCreationCode HumanTranscribed = new LocationCreationCode("HUMAN.TRANSCRIBED");
    /// <summary>
    /// Cut and paste from another window by user
    /// </summary>
    public static readonly LocationCreationCode HumanCutAndPaste = new LocationCreationCode("HUMAN.CUTANDPASTE");
    /// <summary>
    /// Generated by machine
    /// </summary>
    public static readonly LocationCreationCode Machine = new LocationCreationCode("MACHINE");
    /// <summary>
    /// Mensurated (from imagery)
    /// </summary>
    public static readonly LocationCreationCode MachineMensurated = new LocationCreationCode("MACHINE.MENSURATED");
    /// <summary>
    /// Derived from GPS receiver
    /// </summary>
    public static readonly LocationCreationCode MachineGPS = new LocationCreationCode("MACHINE.GPS");
    /// <summary>
    /// Derived from magnetic sources
    /// </summary>
    public static readonly LocationCreationCode MachineMagnetic = new LocationCreationCode("MACHINE.MAGNETIC");
    /// <summary>
    /// Produced by a simulation
    /// </summary>
    public static readonly LocationCreationCode MachineSimulated = new LocationCreationCode("MACHINE.SIMULATED");
    /// <summary>
    /// Corroborated from multiple sources
    /// </summary>
    public static readonly LocationCreationCode MachineFused = new LocationCreationCode("MACHINE.FUSED");
    /// <summary>
    /// btained from a configuration file
    /// </summary>
    public static readonly LocationCreationCode MachineConfigured = new LocationCreationCode("MACHINE.CONFIGURED");
    /// <summary>
    /// Prediction of future (e.g., a from a tracker)
    /// </summary>
    public static readonly LocationCreationCode MachinePredicted= new LocationCreationCode("MACHINE.PREDICTED");
    /// <summary>
    /// Imported from another system (gateway)
    /// </summary>
    public static readonly LocationCreationCode MachineRelayed = new LocationCreationCode("MACHINE.RELAYED");
  }
}
